/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.core.widget;

import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX;

import android.content.res.ColorStateList;
import android.graphics.PorterDuff;
import android.graphics.drawable.Drawable;

import androidx.annotation.Nullable;
import androidx.annotation.RestrictTo;

/**
 * Interface which allows a {@link android.widget.CheckedTextView} to receive tinting
 * calls from {@code CheckedTextViewCompat} when running on API v20 devices or lower.
 * <p>
 * When used on a View annotated with
 * {@link androidx.resourceinspection.annotation.AppCompatShadowedAttributes}, this interface
 * implies that AppCompat shadows the platform's check mark tint attributes. See
 * {@link androidx.resourceinspection.processor} for more details and a full mapping of attributes.
 *
 */
@RestrictTo(LIBRARY_GROUP_PREFIX)
public interface TintableCheckedTextView {

    /**
     * Applies a tint to the check mark drawable. Does not modify the current tint
     * mode, which is {@link PorterDuff.Mode#SRC_IN} by default.
     * <p>
     * Subsequent calls to
     * {@link android.widget.CheckedTextView#setCheckMarkDrawable(Drawable)
     * setCheckMarkDrawable(Drawable)}
     * should automatically mutate the drawable and apply the specified tint and tint mode.
     *
     * @param tint the tint to apply, may be {@code null} to clear tint
     */
    void setSupportCheckMarkTintList(@Nullable ColorStateList tint);

    /**
     * Returns the tint applied to the check mark drawable
     *
     * @see #setSupportCheckMarkTintList(ColorStateList)
     */
    @Nullable
    ColorStateList getSupportCheckMarkTintList();

    /**
     * Specifies the blending mode which should be used to apply the tint specified by
     * {@link #setSupportCheckMarkTintList(ColorStateList)} to the check mark drawable. The
     * default mode is {@link PorterDuff.Mode#SRC_IN}.
     *
     * @param tintMode the blending mode used to apply the tint, may be
     *                 {@code null} to clear tint
     *
     * @see #getSupportCheckMarkTintMode()
     * @see androidx.core.graphics.drawable.DrawableCompat#setTintMode(Drawable,
     * PorterDuff.Mode)
     */
    void setSupportCheckMarkTintMode(@Nullable PorterDuff.Mode tintMode);

    /**
     * Returns the blending mode used to apply the tint to the check mark drawable
     *
     * @see #setSupportCheckMarkTintMode(PorterDuff.Mode)
     */
    @Nullable
    PorterDuff.Mode getSupportCheckMarkTintMode();
}
